Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #140

Merged
merged 1 commit into from
Sep 1, 2020
Merged

Improve documentation #140

merged 1 commit into from
Sep 1, 2020
+15 −2

Conversation

yookoala
Copy link
Contributor

  • More comprehensive code example. Includes details in how to
    retrieve the generated secret, and how to create OTP object
    from the stored secret.
Q A
Branch? v10.0
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets no
License MIT
Tests added no
Doc PR yes

This PR improved code example in the documentation:

  1. Add example how to retrieve the generated secret from a TOTP object.
  2. Remind user to set the TOTP label before generating the QRCode URI. (Or user will encounter error).

@yookoala
Improve documentation
1492ddc 
* More comprehensive code example. Includes details in how to
  retrieve the generated secret, and how to create OTP object
  from the stored secret.
@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 1492ddc on yookoala:doc_updated into f44cce5 on Spomky-Labs:v10.0.

@Spomky Spomky merged commit 1e29506 into Spomky-Labs:v10.0 Sep 1, 2020
@Spomky
Copy link
Member

Spomky commented Sep 1, 2020

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@yookoala @coveralls @Spomky